home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 52 / Amiga Format AFCD52 (Issue 136, May 2000).iso / -screenplay- / shareware / warpquake / warpquakesrc / amiga.readme < prev    next >
Text File  |  2000-02-29  |  7KB  |  215 lines
  1. Short: 68k and PPC ports of winquake, v0.4
  2. Author: Peter McGavin  (p.mcgavin@irl.cri.nz)
  3. Type: game/shoot
  4. Uploader: Peter McGavin  (p.mcgavin@irl.cri.nz)
  5. Version: 0.4
  6.  
  7.  
  8.  
  9.                             awinquake 0.4                   11 Jan 2000
  10.                             -------------
  11.  
  12.  
  13. This archive contains Amiga 68k and PPC ports of winquake, compiled as
  14. directly as possible from ID Software's winquake source code.
  15.  
  16. On 24th Dec 1999 I learnt that ID Software had released the source
  17. code of winquake, glquake, quakeworld and glquakeworld (on 21st Dec
  18. 1999) under GNU Public License (GPL) and made them available by ftp.
  19. So I downloaded them and tried compiling winquake with SAS/C 6.58 for
  20. the Amiga.  This archive represents my results after about 4 evenings
  21. and 2 days.
  22.  
  23. winquake is well written and extremely portable, so it didn't take
  24. long to get it working on my Amiga by cutting and pasting code from
  25. other projects.  I expect other people are doing better ports, e.g,
  26. Frank Wille.  However I haven't seen any legal ones yet, and as it
  27. didn't take very long to get a base version running, I thought I'd
  28. release what I've done.  If you're doing your own port, feel free to
  29. take source code from mine, but remember there's no guarantee.
  30.  
  31. Sorry I haven't even looked at the glquake and quakeworld source code
  32. yet.
  33.  
  34. You can get all the original ID Software quake source from:
  35.  
  36.    ftp://ftp.cdrom.com/pub/idgames/idstuff/source/q1source.zip
  37.  
  38. Source code of awinquake is necessarily in a separate archive on
  39. Aminet.  The GPL license requires that the source code of all
  40. modifications to Quake is made freely available.
  41.  
  42.  
  43.  
  44. FEATURES:
  45. ---------
  46.  
  47. Both 68k and PPC versions are provided.
  48.  
  49. Both versions are OS-friendly and multitask.
  50.  
  51. Both versions put up an ASL requester for the ScreenMode.
  52.  
  53. awinquakeppc uses Joseph Fenton's PPC c2p routine from ADoomPPC and
  54. triple buffering in AGA modes.
  55.  
  56. Sound effects are included.  Also CD audio for music works if you use
  57. ClickBoom's AmigaQuake CDROM.  You need cdplayer.library (from Aminet)
  58. for this.
  59.  
  60. Networking for TCP/IP is included.
  61.  
  62. awinquakeppc works with either PowerUp or WarpOS.  With WarpOS, use
  63. Frank Wille's ppc emulation library.
  64.  
  65. awinquakeppc is mostly compiled with SAS/C scppc.  However, the
  66. innermost rendering routines are compiled with ppc-amigaos-gcc.  This
  67. results in a small speedup (about 3%) over compiling everything with
  68. scppc.
  69.  
  70. My modified source code should still compile for Linux (APUS),
  71. Solaris, Win95, etc, with no changes --- untested.
  72.  
  73. Speeds over 37 fps have been observed for "timedemo demo2" in 320x200
  74. on a 233 MHz PPC Amiga 3000 with CyberVisionPPC.
  75.  
  76. I added a -fps option, but see the note below about bus speed before
  77. you believe the numbers you see.
  78.  
  79.  
  80.  
  81. LIMITATIONS:
  82. ------------
  83.  
  84. My 68k version is much slower than ClickBoom's commercial version.  I
  85. use my 68k version primarily for debugging.
  86.  
  87. Only the PPC version has optimised c2p for AGA.  In fact I don't
  88. recommend the 68k version at all.  Buy Clickboom's version.
  89.  
  90. Only keyboard control.  No mouse, joystick or joypad yet.
  91.  
  92. No AHI yet either, sorry.
  93.  
  94. I haven't put much effort into optimising the code yet, apart from
  95. trying different compilers and compiler options.
  96.  
  97. Untested code.  Your mileage may vary.
  98.  
  99.  
  100.  
  101. REQUIREMENTS:
  102. -------------
  103.  
  104. A 68020+ Amiga running at least Kickstart 3.0, with at least about 16
  105. Mb of fastmem.
  106.  
  107. An FPU is required.
  108.  
  109. You need either a gfx-card or AGA.  ECS alone is not sufficient.
  110.  
  111. A TCP/IP stack is required for networking, e.g, AmiTCP or Miami.
  112. An ethernet card is strongly recommended.
  113.  
  114. I use a stack size of 500000 bytes.  I'm not sure what the minimum
  115. stack size is.  150000 bytes is definitely too small.
  116.  
  117. An MMU is neither required nor used.
  118.  
  119. You need cdplayer.library from Aminet, or start with -nocdaudio.  The
  120. game searches for Clickboom's CDROM for cdaudio (volume name "QUAKE".)
  121.  
  122. You need the Quake 1 PAK files and other support files from either a
  123. commercial or shareware version of Quake.  Assuming you've already
  124. installed AmigaQuake or a PC version, put awinquake or awinquakeppc in
  125. the same directory as the original quake executable.
  126.  
  127. To enable mouse control, use -mouse.  To leave the mouse pointer
  128. visible, use -mousepointer.
  129.  
  130.  
  131.  
  132. KNOWN BUGS, PROBLEMS AND SOLUTIONS:
  133. -----------------------------------
  134.  
  135. If you get the message "file is not executable" when you start
  136. awinquakeppc, try using runelf, or run another program that uses
  137. ppc.library first.  Also, make sure the executable bit is set in the
  138. file protection mask of awinquakeppc.
  139.  
  140. Random crashes, especially crashes on exit, may be caused by stack too
  141. small.  Set a large stack, say 500000 bytes, especially if networking.
  142. Use the AmigaOS STACK command to set the stack size before you start
  143. awinquake or awinquakeppc.
  144.  
  145. There is a -mem option for allocating a different size heap than the
  146. default.  For example, "awinquakeppc -mem 24" starts awinquake with a
  147. 24 Megabyte heap.  The default size is 8 Megabytes.  Some Quake
  148. add-ons, such as Malice, require a larger heap.  Also, a larger heap
  149. size reduces disk accesses.  If you are very short of memory, try a
  150. smaller heap, e.g, "awinquakeppc -mem 6".
  151.  
  152. The game may "stick" for a few seconds every few minutes when the
  153. cdplayer loops.  Sorry, no solution for this yet except -nocdaudio.
  154.  
  155. If the game reports the wrong bus speed at the start, then the game
  156. will run at the wrong speed and audio may sound broken up.
  157. Furthermore, all reported times and fps ratings (e.g, for timedemo
  158. demo2) will be wrong.  Override with, e.g (for 66 MHz bus):
  159.  
  160.         awinquakeppc -bus 66666667
  161.  
  162. If the game takes too long to load, try using the AmigaOS ADDBUFFERS
  163. command.
  164.  
  165. The TCP/IP networking code seems to be rather flaky.  I successfully
  166. used it over ethernet with other Amigas running awinquakeppc, other
  167. Amigas running Clickboom's Quake and other PCs running Quake 1.06.
  168. (awinquake is a port of winquake 1.09.)  However, sometimes the server
  169. wasn't seen by the client looking for it.  In that case the solution
  170. is to type in the IP number of the server.  Sometimes I wasn't able to
  171. make a connection at all, or when I made a connection, the players
  172. couldn't move.  Then, when I tried again later, it worked just fine.
  173.  
  174.  
  175.  
  176. HISTORY:
  177. --------
  178.  
  179. v0.4    7 Jan 2000
  180.  
  181. Should work under Kickstart 3.0 now.
  182.  
  183. Added -mouse and -mousepointer.
  184.  
  185. awinquakeppc should calculate the correct bus speed now.
  186.  
  187. Now writes config.cfg on exit.
  188.  
  189. Handles slashes and colons in directory names better.
  190.  
  191.  
  192.  
  193. v0.3    4 Jan 2000
  194.  
  195. Fixed the crash that occurred if you don't have cybergraphics.library
  196.  
  197. Added -mem parameter.
  198.  
  199.  
  200.  
  201. v0.2   30 Dec 1999
  202.  
  203. First Aminet release.
  204.  
  205.  
  206.  
  207. THANKS:
  208. -------
  209.  
  210. Thanks to John Carmack and ID Software for one of the best games ever!
  211.  
  212.  
  213.  
  214. Peter McGavin.  (p.mcgavin@irl.cri.nz)
  215.